home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / onlin14.zip / ONLINE.DOC < prev    next >
Text File  |  1992-07-02  |  22KB  |  547 lines
  1.  
  2.  
  3.                        ============================
  4.                                  OnLine!
  5.                        ============================
  6.                            (c)1992 T&J Software
  7.  
  8.         One of the T&J Software Collection of multi-BBS door programs.
  9.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  10.               UltraBBS, Telegard, TriBBS, Remote Access, and WWIV
  11.  
  12.                        VERSION 1.40     07/01/92
  13.  
  14.                                    By
  15.  
  16.                                Tom Wildoner
  17.                              397 West Broadway
  18.                               Jim Thorpe, PA
  19.                                   18229
  20.                             VOICE (717)325-9480
  21.                    *between 5:30 & 10:00 p.m. Eastern Time
  22.  
  23.                                   From
  24.  
  25.                                The T&J BBS
  26.                               (717)325-9481
  27.                         1200/2400/9600/19200/38400
  28.                                24 Hours/Day
  29.  
  30. LATEST VERSION:
  31. ===============
  32.  
  33. Please call the T&J BBS for the latest version of this program.
  34.  
  35. LEGALITIES:
  36. ===========
  37.  
  38. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  39. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  40. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  41. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  42. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  43. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  44.  
  45. DISTRIBUTION:
  46. =============
  47.  
  48. You may make this file available for downloading from your BBS or you may
  49. upload it to any BBS of your choice, provided that you do not make any
  50. changes to the contents of the archive (ZIP file). The archive and its
  51. individual contents may not be used by any service that charges any money
  52. whatsoever, without the written permission of the author.
  53.  
  54. PROGRAM DESCRIPTION:
  55. ====================
  56.  
  57. OnLine! is basically a way for you, the SysOp, to setup your own online
  58. type of magazine or your own online search door. You can make your own
  59. Hello and Goodbye screens, and you can have up to 225 articles/ANSI screens
  60. for your users to read/search online and have them broken down into 15
  61. different sub-menus.
  62.  
  63. Think of OnLine as a "shell" for you to build on. You can customize it
  64. to your favorite colors, text files, ANSI screens etc.
  65.  
  66. When viewing TEXT files, you may SEARCH the text file for a KEYWORD,
  67. goto the next page (like PAGE DOWN), and goto the previous page (like
  68. PAGE UP). If you have the download option set to Yes, your users can
  69. even download the text files or ANSI screens using ZModem right from
  70. within the door.
  71.  
  72. ANSI files simply display to the user and then return to the main menu.
  73. There is no way to "search" an ANSI file.
  74.  
  75. NOTE:
  76. =====
  77.  
  78. The ONLINE.KEY file that is distributed with this door does NOT expire!
  79. This is simply here so the door has a KEY to read. When you register,
  80. you will receive a new ONLINE.KEY file.
  81.  
  82. You may only display/use 2 sub-menus with 2 articles in each until
  83. the door is registered. After you register, the limit is 225 articles
  84. or ANSI screens, and all future upgrades to the door are free.
  85.  
  86. Running the door locally (ONLINE! LOCAL) will let you evaluate the
  87. door with no crippling effects. You can use the entire 15 sub-menus
  88. and all 225 articles! The 2 sub-menu, 2 article per sub-menu limit
  89. will only occur when running the on your BBS.
  90.  
  91.  
  92. FEATURES:
  93. =========
  94.            --- Desqview Aware.
  95.            --- COM1-4 support and non-standard IRQ's.
  96.            --- Colorful ANSI screens.
  97.            --- Chat function.
  98.            --- NO BRUN module needed for play.
  99.            --- BETA tested on five different boards.
  100.            --- Will return to BBS on dropped carrier.
  101.            --- Will TIMEOUT a player after 5 minutes of no activity.
  102.            --- Use of HOT KEYS while in the door.
  103.            --- Support BBS available.
  104.            --- 15 Sub-Menus.
  105.            --- 225 Total Articles.
  106.            --- Downloading Option.
  107.            --- Four Archive Formats Available.
  108.  
  109.  
  110. INSTALLATION: (using the ONLINE! SETUP command)
  111. ===============================================
  112.  
  113. Run ONLINE! using the command string SETUP (i.e.  ONLINE! SETUP)......
  114.  
  115.      Just type:  ONLINE! SETUP
  116.  
  117. First let's make your OnLine configuration file.....
  118.  
  119. Select item number one from the menu and answer all the questions. You
  120. will be prompted to enter the complete PATH to your caller data file
  121. (DOOR.SYS, CALLINFO.BBS, etc....), your BBS name, sysop first and last
  122. name, if you want downloading available, and the archiver you wish to
  123. use when the user tries to download a file.
  124.  
  125. Next, its time to decide how many articles you will have in your first
  126. online issue! If you have not done this, quit the SETUP program and get
  127. all your files lined up then come back to this point. If you plan on
  128. allowing your users to download the files, you MUST have all the files
  129. in the ONLINE directory!
  130.  
  131. You should have all your files in the ONLINE directory, decide how many
  132. sub-menus you will have, and what articles/ANSI screens will be in each
  133. sub-menu. It would be best to write all this information down.
  134.  
  135. Select number two from the menu. You will be prompted for how many
  136. sub-menus will be in ONLINE. Then, it will ask for a description of
  137. each of the sub-menus and the name of each article in each of the
  138. appropriate sub-menus (enter it just like a DOS filename, WCLIST.TXT,
  139. etc...). After each filename it will ask if it is a TEXT file or an ANSI
  140. file. Enter T or A. Yep, you can have either TEXT FILES or some ANSI
  141. SCREENS to show to your users! If it is a TEXT file, you will be prompted
  142. for what color you want the text file in. Just select the number of the
  143. color you want.
  144.  
  145. NOTE: Do not use any comma's in any of the file description or
  146.       sub-menu titles.
  147.  
  148. SETUP will verify each file and create a file called MENU.CFG which
  149. will contain how many sub-menus you have and the title of each of the
  150. sub-menus. It will also create a seperate MENUx.CFG for each sub-menu
  151. that you have. In each of these MENUx.CFG files it will have all the
  152. important information for each of your files.
  153.  
  154. That's it! The door is ready to run!
  155.  
  156. Anytime you add/change any of the text/ANSI file(s) you MUST run item
  157. #3 in SETUP! (the VERIFY option). Also, your text file must be clean!
  158. No clear screens or line feeds etc.... Having the clear screen commands
  159. of page advance commands in the text files will play some tricks on the
  160. monitor.
  161.  
  162. SETUP also has a handy feature for interpreting the .LOG file. When run,
  163. it will make a text file called STAT.TXT which will tell you how many
  164. times the door was opened and how many times each article/screen was
  165. read/viewed. This is handy if you wish to make a monthly type of online
  166. magazine for the users. Use the STAT.TXT file every month and see what
  167. articles are most popular!
  168.  
  169.  
  170. INDIVIDUAL FILES: (if you would like to edit them yourself)
  171. ================
  172.  
  173. The MENU.CFG (example only)
  174.  
  175. 4                                        'How many sub-menus
  176. "EPA Regulations (3/92 to 4/92)"         \
  177. "Federal Register (1/92 to 4/92)"         The title's of each of the
  178. "Browse THREE different BBS Listings!"    sub-menus you have
  179. "Hazardous Waste Superfund Newsletter"   /
  180.  
  181. The MENU1.CFG (example only)
  182.  
  183. 2
  184. "EPA Regulations for March 1992","epareg92.mar",1023,"t",7
  185. "EPA Regulations for April 1992","epareg92.apr",711,"t",7
  186.  
  187. LINE 1: Shows how many articles there are in this particular sub-menu.
  188. LINE 2 and 3: Show examples of the information about each article. The
  189. first item is the article description, second item is the actual
  190. article name, third item is how many lines of text there are in the
  191. file, fourth item will show a "t" if it is TEXT or an "a" if it is
  192. an ANSI screen, and the last item is the color of the text.
  193.  
  194. For each sub-menu there will be a cooresponding MENUx.CFG file with
  195. all the details of the articles contained within.
  196.  
  197.  
  198. The SYSOP.CFG file:
  199.  
  200. "Y"
  201. "DSZ"
  202. " ha both sz "
  203. "PKZIP "
  204.  
  205. LINE 1: Is set to "Y" if downloading is allowed or "N" if downloading
  206.         is not allowed.
  207. LINE 2: Download protocol -- you MUST have DSZ or GSZ in your PATH! --
  208.         If you are using GSZ instead of DSZ, just replace the DSZ with
  209.         GSZ.
  210. LINE 3: Download protocol -- leave this as it is. The leading and
  211.         trailing space must remain! Please read your DSZ or GSZ
  212.         documentation if you try changing anything here.
  213. LINE 4: Your ARCHIVE protocol. SETUP will set this up for you, but if
  214.         you wish to change this manually use one of the following:
  215.         "PKZIP " -- for PKZIP
  216.         "LHA a " -- for LHA
  217.         "PAK a " -- for PAK
  218.         "ARJ a " -- for ARJ
  219.         The trailing space is VERY important!
  220.  
  221. The port for the download option is determined from the caller information
  222. file. We cannot be sure that the download option will work on every BBS
  223. especially those that use non-standard COM port IRQ's!
  224.  
  225.  
  226. CONFIGURATION:
  227. =============
  228.  
  229. Example configuration file for PCBOARD.SYS
  230. ------------------------------------------
  231.  
  232. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  233. T&J Software        <=-  (Change this to your BBS name)
  234. Tom                 <=-  (The Sysop's first name)
  235. Wildoner            <=-  (The Sysop's last name)
  236.  
  237. Example configuration file for USERS.SYS
  238. ----------------------------------------
  239.  
  240. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  241. T&J Software        <=-  (Change this to your BBS name)
  242. Tom                 <=-  (The Sysop's first name)
  243. Wildoner            <=-  (The Sysop's last name)
  244.  
  245. Example configuration file for DOOR.SYS
  246. ---------------------------------------
  247.  
  248. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  249. T&J Software        <=-  (Change this to your BBS name)
  250. Tom                 <=-  (The Sysop's first name)
  251. Wildoner            <=-  (The Sysop's last name)
  252.  
  253. Example configuration file for USERINFO.DAT
  254. -------------------------------------------
  255.  
  256. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  257. T&J Software        <=-  (Change this to your BBS name)
  258. Tom                 <=-  (The Sysop's first name)
  259. Wildoner            <=-  (The Sysop's last name)
  260. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  261.  
  262. Example configuration file for CALLINFO.BBS
  263. -------------------------------------------
  264.  
  265. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  266. T&J Software        <=-  (Change this to your BBS name)
  267. Tom                 <=-  (The Sysop's first name)
  268. Wildoner            <=-  (The Sysop's last name)
  269.  
  270. Example configuration file for DORINFOx.DEF
  271. -------------------------------------------
  272.  
  273. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  274.                           where 'x' is the BBS Node number.
  275. T&J Software        <=-  (Change this to your BBS name)
  276. Tom                 <=-  (The Sysop's first name)
  277. Wildoner            <=-  (The Sysop's last name)
  278.  
  279. Example configuration file for SFDOORS.DAT
  280. ------------------------------------------
  281.  
  282. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  283. T&J Software        <=-  (Change this to your BBS name)
  284. Tom                 <=-  (The Sysop's first name)
  285. Wildoner            <=-  (The Sysop's last name)
  286.  
  287. Example configuration file for CHAIN.TXT
  288. ----------------------------------------
  289.  
  290. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  291. T&J Software        <=-  (Change this to your BBS name)
  292. Tom                 <=-  (The Sysop's first name)
  293. Wildoner            <=-  (The Sysop's last name)
  294.  
  295. Example configuration file for GTUSER.BBS
  296. -----------------------------------------
  297.  
  298. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  299. T&J Software        <=-  (Change this to your BBS name)
  300. Tom                 <=-  (The Sysop's first name)
  301. Wildoner            <=-  (The Sysop's last name)
  302. 1                   <=-  (COM port number - defaults to 1)
  303. 1                   <=-  (Node number - defaults to 1)
  304.  
  305. Example Batch File
  306. ==================
  307.  
  308. A sample batch file is included and is similer to the following:
  309.    ECHO OFF
  310.    CD\DOORS\ONLINE          <=- Switch to the door's Directory.
  311.    ONLINE! ONLINE!.CFG      <=- Execute the door program and pass the
  312.                                 configuration filename to the program.
  313.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  314.    BOARD                    <=- Restart BBS.
  315.  
  316.  
  317. This Door is multi-node  compatible so you may run more than 1 node from
  318. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  319. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  320. variables, (q.v.)
  321.  
  322. Environment Variables
  323. =====================
  324.  
  325. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  326. variables. Non-PCBoard systems may also use these variables by including
  327. the following in either your BBS batch or AUTOEXEC.BAT
  328.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  329.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  330. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  331. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  332. .CFG file for multi-node operation!
  333.  
  334. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  335. command line.  For example:
  336.  
  337.      ONLINE! ONLINE!.CFG /5
  338. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  339.      ONLINE! ONLINE!.CFG /%IRQ%
  340.  
  341. This tells the program to use IRQ 5 instead of the standard IRQ.
  342.  
  343.  
  344. Sysop Keys
  345. ==========
  346.  
  347. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  348.          written to DOOR.SYS and USERS.SYS
  349. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  350.          and/or written to DOOR.SYS and USERS.SYS
  351. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  352. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  353.          and/or written to DOOR.SYS and USERS.SYS
  354. F8    -  Returns the caller involuntarily to the BBS.
  355. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  356.          and/or written to DOOR.SYS and USERS.SYS
  357. F10   -  Activates SysOp CHAT mode within the DOOR.
  358. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  359. UP    -  Give the caller extra time while in the DOOR.  
  360. DN    -  Subtract time from the caller while in the DOOR. 
  361. HOME  -  HELP key for Status Line options.
  362. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  363. ALT-X -  PCBoard will exit after current caller logs off. Value is
  364.          passed to PCBoard. Not available on non-PCBoard systems.
  365.  
  366.  
  367. VERIFY COMMAND STRING:
  368. =====================
  369. This is a suplimental command string which was added because of a need
  370. of one of my BETA testers to verify his OnLine! text files on a nightly
  371. basis.
  372.  
  373. Basically, if you have text files (in OnLine!) that will change from
  374. day to day, they need to be re-verified for OnLine! to operate properly.
  375. Such text files as your BBS file listing (which will change). Thus,
  376. you can run ONLINE! VERIFY as part of your nightly maintenance routines
  377. to make all the adjustments for you without you having to manually run
  378. the ONLINE! SETUP command.
  379.  
  380. To run the verifier program simply type:   ONLINE! VERIFY
  381.  
  382.  
  383. SCREEN DESIGN:
  384. =============
  385. Now it's time to make your screens! (If you wish) First, design your
  386. HELLO.SCR for the door! Just work on line 1-22 for the design. Do not
  387. save any of your screens using a 'clear screen' they should be saved
  388. using a 'home cursor', at least if you are using TheDraw. Also, save
  389. the screens using the BLOCK SAVE command, do not simply save it using
  390. the SAVE command. That could cause some problems with the display. These
  391. rules will hold true for both the HELLO.SCR and the GOODBYE.SCR screens.
  392.  
  393. When block saving your screens, just highlight rows 1 to 22 for the
  394. save.
  395.  
  396. After your done with your HELLO.SCR it's time to make your GOODBYE.SCR!
  397. Do whatever you want here! Just use lines 1-22 for your screen design
  398. following the same rules as above.
  399.  
  400.  
  401. RUNNING LOCALLY:
  402. ===============
  403.  
  404. To run in LOCAL mode simply type ONLINE! LOCAL
  405.  
  406.  
  407. ADDING ONE NEW TEXT FILE:
  408. =========================
  409.  
  410. If you have OnLine! up and running, and wish to add a new text file
  411. to an existing sub-menu just do the following:
  412.  
  413. Let's say you want to add a new text file to sub-menu #1 -- simply
  414. open the MENU1.CFG file,
  415.  
  416. 2
  417. "EPA Regulations for March 1992","epareg92.mar",1023,"t",7
  418. "EPA Regulations for April 1992","epareg92.apr",711,"t",7
  419.  
  420. Change line 1 from 2 to 3, on line 4 type the following (using your
  421. own information):
  422.  
  423. "Your new description","filename.txt",0,"t",7
  424.  
  425. NOTE: Do NOT use any comma's in any of the description or sub-menu
  426.       titles!
  427.  
  428. After you do this, save your changes and run ONLINE! VERIFY -- The
  429. verifier will verify this new entry and plug in the number of lines
  430. in this file.
  431.  
  432. The text color option (the last item) must be one of the following:
  433.  
  434.      1 = Low Intensity Blue
  435.      2 = Low Intensity Green
  436.      3 = Low Intensity Cyan
  437.      4 = Low Intensity Red
  438.      5 = Low Intensity Magenta
  439.      6 = Low Intensity Yellow
  440.      7 = Normal White
  441.      8 = Gray
  442.      9 = High Intensity Blue
  443.     10 = High Intensity Green
  444.     11 = High Intensity Cyan
  445.     12 = High Intensity Red
  446.     13 = High Intensity Magenta
  447.     14 = High Intensity Yellow
  448.     15 = High Intensity White
  449.  
  450.  
  451.  
  452. ADDITIONAL HELP:
  453. ===============
  454.  
  455. When should I use VERIFY in the SETUP program?
  456.  
  457. ---  If you edit an existing text file (taking lines out, etc..) then
  458.      you must VERIFY all the files again.
  459.  
  460. What if I have an ANSI'ed TEXT file?
  461.  
  462. ---  No problem! In the SETUP program simply identify this file as an
  463.      ANSI screen. You will not be able to SEARCH or anything else. The
  464.      user will be prompted for a "Press ENTER to continue or E to end".
  465.  
  466. When I am viewing a TEXT screen, the screen blanks and gets a little wierd.
  467.  
  468. ---  You must have some CLEAR SCREEN or TOP OF PAGE commands in the
  469.      TEXT file, find them and remove them.
  470.  
  471. I can't seem to get the download option to work!
  472.  
  473. ---  Due to the variety between BBS's packages and COM PORT setups,
  474.      the download option will probably not work on all systems. Change
  475.      line 1 of the SYSOP.CFG file to "N". Call my support board if you
  476.      have any problems with this -- maybe we could help you out.
  477.  
  478. The program (SETUP or VERIFY) keeps bombing when the text file(s) is
  479. being verified!
  480.  
  481. ---  You may have something wierd in your text file. Take a look at it
  482.      and make sure there is no garbage inside the file.
  483.  
  484. If any internal errors do occur, check for a file called DFRAME.ERR
  485. and let me know what the error code says.
  486.  
  487. Several people have been having problems with their Trident SVGA
  488. cards and the ANSI screens not showing up correctly. To fix this,
  489. check you utility disk that came with your Trident card for a program
  490. called TANSI.SYS or something similar. Replace your old ANSI.SYS
  491. with this version of it. This will correct the problems.
  492.  
  493. Several people have had problems running some of the doors under
  494. Livecat. Try copying your user information files to the Dollarmania
  495. sub-directory and then telling Dollarmania to look for them there.
  496. Add something like this to beginning of your door batch file:
  497.  
  498.        COPY C:\WC30\WCWORK\NODE1\DOOR.SYS C:\WC30\DOOR\ONLINE
  499.  
  500. Don't forget to change line one in your ONLINE.CFG file to reflect
  501. the new location of the DOOR.SYS file.
  502.  
  503. Please feel free to contact me if you have any problems at all.
  504.  
  505.  
  506. UPGRADING:
  507. ==========
  508.  
  509. If you are upgrading from v1.0 through v1.3 you will have to reinstall
  510. the door from scratch.
  511.  
  512.  
  513. FUTURE VERSIONS:
  514. ================
  515.  
  516. --->> Your the editor, let me know what you would like to see added!!
  517.  
  518.  
  519. VERSION HISTORY:
  520. ===============
  521. Version 1.00 ......... First release. 05-15-92
  522. Version 1.10 ......... Fixed problem with the unregistered version allowing
  523.                        3 articles at a minimum. Fixed problem with SETUP
  524.                        not allowing more than 10 articles. 05-18-92
  525. Version 1.20 ......... Fixed problem when the users CAPS LOCK was on. This
  526.                        was not a problem with the door code, but a problem
  527.                        in the DoorFrame door routines. Added the SETUP and
  528.                        VERIFY programs to the main code. You can now use
  529.                        command line options of SETUP and VERIFY. 05-24-92
  530. Version 1.30 ......... Small bug found (thanks Jim!) when the door was
  531.                        initially setup and the files were being verified!
  532.                        05-30-92
  533. Version 1.40 ......... Added a little bit more color throughout the door,
  534.                        no need to mess around with the MAIN.SCR anymore
  535.                        OnLine! makes it for you, added support for up to
  536.                        15 sub-menus with each sub-menu containing 15 articles,
  537.                        and added support to download selected articles
  538.                        using ZModem. 07-01-92
  539.  
  540. REGISTERING:
  541. ============
  542. That's all there is to it! If you have any problems or questions
  543. please feel free to call the T&J BBS at (717)325-9481 and join the
  544. T&J Software Conference.
  545.  
  546. See the enclosed registration form for ordering!  (REGISTER.TXT)
  547.